Analytics blocks
Analytics blocks enable Architect to consume Analytics developed in third party applications. These Analytics can then either run within a Proficy CSense blueprint, or enable third party clients to run Proficy CSense within their own execution environment.
Analytics blocks are used to load an analytic calculation into a blueprint. There can be any number of Analytics found on the Common Analytic Framework (CAF) palette, each with an individual algorithm and therefore performing different functions on data. The blueprint can then be deployed as an Action Object for online deployment, or as an ISV (Independent Service Vendor) for use in clients' external applications.
Each Analytic has a different requirement for data, determined by the algorithm of the Analytic. This includes the required format and mapping of the input data, how the output data will be presented and integrated back into the blueprint, and the related properties of the Analytic data. Consumers of the Analytic must know what specific information their Analytic requires before using it.
One of the output fields of the Analytics block is a success field (an integer field) which defines whether the Analytic executed or not. This can be used later within the blueprint, as well as when deploying the blueprint as an Action Object within the CSense Runtime Manager.
Updating the Common Analytic Framework palette
-
The CAF palette will update to reflect the Analytics in the repository every time the Architect opens.
-
Manually refresh the CAF palette by clicking [Tools] > [Update Palette].
-
Duplicates: The Analytic name and version number combination needs to be unique. Duplicate Analytics will not be added on clicking [Update Palette]. You will see a warning notice listing the duplicates.
Analytics block
Block Type
Common Analytics Framework block
Input port
There will be 1 or more input fields, as defined by the Analytic. Inputs can be of any data type, as required by the Analytic, and will be mapped during configuration of the inputs.
Parameters port
There are no parameter ports.
Output port
There will be 1 or more output fields, as defined in the Analytic. Outputs can be of any data type, as required by the Analytic, and will be mapped during configuration of the outputs.
Functions performed on tags
These are determined by the algorithm of the Analytic.
Behavior Settings
Depends on the publisher of the CAF analytic block, several options can be available for configuration
Execution state
If the CAF analytic block is published by CSense, there will be a option to enable maintaining execution state. Enabling this will cause all internal registers, etc. in the analytic to be kept in memory during execution thus increase performance (speed). The default option is enabled. however, if speed is not a concern but you want to minimize the memory usage, you can disable the option.
If the CAF analytic is published by third parties. there is no option and the system wonot maintain any state for the analytic.
Data type conversion error handling
When a data type conversion is needed, Proficy CSense follows certain conversion rules shown in Section: data type conversion. when there is an error in data type conversion, you can choose how system handles it.
If the CAF analytic block is published by CSense, the system will set the qualities of output fields to bad.
If the CAF analytic block is published by third parties, you can choose one of the two options
-
-
Stop Execution and log all conversion errors.
-
Continue to execute the blueprint but set the success result to false. In this case no logging will occur. the CAF analytic will not be called/executed but the rest of the blueprint will be executed.
-
Runnability
Minimum requirements for runnability of the Analytics blocks:
-
A valid Analytic .xml file
-
The Analytic must have inputs and these inputs must be mapped
Right click on the Analytic within the blueprint and select [Check Runnability] to test if the block configuration is all correct, and the block will run on execution.
The following are causes for failure and, on failure, a message is displayed indicating the Proficy CSense field and Analytic OSA-CBM field concerned if applicable.
-
Analytic properties:
-
-
All property values must have a value defined
-
If there is a range defined for this property, the value must fall within the range
-
The value must be of the data type defined for this property
-
If it is a composite property, the parent row will have a blank value and its child composite rows must have values
-
-
Analytic inputs:
-
-
One or more Analytic inputs are not mapped to an input field
-
The Proficy CSense field that the Analytic input was mapped to, is not found or the data types are not compatible
-
Bad syntax for input field Array, Vector, or Complex array mappings.
-
-
Analytic outputs:
-
-
The Proficy CSense field that the Analytic output was mapped to, is not found or the data types are not compatible
-
Related topics: